Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

std.json: Document opEquals #8975

Merged
merged 1 commit into from
Jul 19, 2024
Merged

std.json: Document opEquals #8975

merged 1 commit into from
Jul 19, 2024

Conversation

dkorpel
Copy link
Contributor

@dkorpel dkorpel commented Apr 8, 2024

No description provided.

@dlang-bot
Copy link
Contributor

Thanks for your pull request and interest in making D better, @dkorpel! We are looking forward to reviewing it, and you should be hearing from a maintainer soon.
Please verify that your PR follows this checklist:

  • My PR is fully covered with tests (you can see the coverage diff by visiting the details link of the codecov check)
  • My PR is as minimal as possible (smaller, focused PRs are easier to review than big ones)
  • I have provided a detailed rationale explaining my changes
  • New or modified functions have Ddoc comments (with Params: and Returns:)

Please see CONTRIBUTING.md for more information.


If you have addressed all reviews or aren't sure how to proceed, don't hesitate to ping us with a simple comment.

Bugzilla references

Your PR doesn't reference any Bugzilla issue.

If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog.

Testing this PR locally

If you don't have a local development environment setup, you can use Digger to test this PR:

dub run digger -- build "master + phobos#8975"

assert(JSONValue(0u) == JSONValue(0));
assert(JSONValue(0u) == JSONValue(0.0));
assert(JSONValue(0) == JSONValue(0.0));
assert(JSONValue(10).opEquals(JSONValue(10.0)));
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I use == here, the generator will convert it to:

writeln(JSONValue(10)); // JSONValue(10.0)

Hence I'm calling opEquals explicitly here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recall such awkward situations coming up before. Maybe it's time to add some kind of // no-writeln syntax to https://github.com/dlang/dlang.org/blob/master/ddoc/source/assert_writeln_magic.d ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or it could exempt documented unittests under opEquals

@RazvanN7 RazvanN7 merged commit d5780aa into dlang:master Jul 19, 2024
10 checks passed
@dkorpel dkorpel deleted the json-equals-doc branch July 19, 2024 08:01
RubyTheRoobster pushed a commit to RubyTheRoobster/phobos that referenced this pull request Aug 6, 2024
RubyTheRoobster pushed a commit to RubyTheRoobster/phobos that referenced this pull request Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants